home *** CD-ROM | disk | FTP | other *** search
/ Shareware Super Platinum 8 / Shareware Super Platinum 8.iso / mac / PROGTOOL / AE.ZIP;1 / AE.DOC < prev    next >
Encoding:
Text File  |  1993-04-26  |  5.0 KB  |  137 lines
  1. Assembler Editor 1.01     by Kip Irvine             (AE.DOC)
  2.  
  3.  
  4.                DOCUMENTATION FOR THE ASSEMBLER EDITOR
  5.  
  6. I. INTRODUCTION
  7.  
  8. This editor was created using Borland Turbo Vision (tm) as a
  9. multi-window popup editor for Kip Irvine's "Assembly Language 
  10. for the IBM-PC", 2nd Edition, 1993, Macmillan publishing Co., 
  11. ISBN 0-02-359651-1.
  12.  
  13. You are welcome to use and distribute this editor free of charge.
  14. You may not sell the editor for profit without the written consent
  15. of Kip Irvine.
  16.  
  17. You should be able to use this editor with any assembler of your
  18. choice. I have tested it with Borland's TASM 3.2 and Microsoft
  19. MASM 5.1  There are installation options that let you set the 
  20. name and path of the assembler, linker, debugger, and link 
  21. library (if any).
  22.  
  23. Run the editor by typing its name and an optional name of
  24. a file to be edited. A default extension of ASM is assumed.
  25. Examples:
  26.               AE                   ; no file being edited
  27.               AE prog1             ; edits prog1.asm 
  28.               AE myfile.dta        ; edits myfile.dta
  29.     
  30. If you have any comments about the book or this editor, you are
  31. welcome to send me a Compuserve EasyPlex message at 76137,2364,
  32. or contact me at:
  33.                       Kip Irvine
  34.                       CIS Department, Rm. 2130
  35.                       Miami-Dade Community College-Kendall
  36.                       Miami, FL 33176
  37.                       305/237-2806
  38.  
  39. Enjoy!
  40.  
  41. --Kip Irvine
  42.  
  43.  
  44. II.  INSTALLING THE PROGRAM PATHNAMES
  45.  
  46. The editor is shipped with a default configuration file (AE.CFG)
  47. containing sample pathnames for the assembler, editor, linker, and
  48. link library. Notice that you must include the extensions with the
  49. executable filenames, but not with the link library name. No doubt
  50. you will want to change these to suit your own directory setup:
  51.  
  52.   Assembler path:   C:\ASM\TASM.EXE
  53.          options:   /z/zi
  54.      Linker path:   C:\ASM\TLINK.EXE
  55.          options:   /v
  56.    Debugger path:   C:\ASM\TD.EXE
  57.     Library path:   C:\ASM\CONSOLE
  58.  
  59. (The CONSOLE.LIB file is supplied on a disk with the Irvine book,
  60. and is available in the Borland Turbo assembler forum on 
  61. Compuserve.)
  62.  
  63. To change these paths, select the "Set Path Names" option from 
  64. the "Run" menu. All changes are saved when exiting the editor. 
  65. The AE.CFG file is saved in the current directory, so if you're 
  66. working in various directories, copy AE.CFG to each directory.
  67.  
  68.  
  69. III.  EDITING A PROGRAM
  70.  
  71. Choose the "Open" command from the "File" menu to open an existing
  72. source program. Or choose "New" from the same menu to create a new
  73. program. The menu options conform to the standard CUA interface in
  74. Borland's editors.
  75.  
  76. Be sure to save the file before assembling it, by pressing F2 (or
  77. choose "Save As" from the "File" menu).
  78.  
  79. You may open multiple edit windows, each with a different source 
  80. file if you wish. Text may be cut and pasted between windows with 
  81. the mouse, or by marking text with the Shift-Arrow keys.
  82.  
  83.  
  84. IV.  ASSEMBLING A PROGRAM
  85.  
  86. If you have more than one window open, set the focus to the window
  87. containing the program you want to assemble. You may do this by 
  88. pressing F6 to cycle through the windows to the desired one, or 
  89. you may click the mouse in the right window.
  90.  
  91. Choose "Assemble" from the "Run" menu. The assembler will take 
  92. over the screen until it is finished. Press a key to return to 
  93. the editor. If there were any errors or warnings, the editor will 
  94. remind you by displaying a dialog box with the error code number 
  95. returned by the assembler (this is the same as the ErrorLevel 
  96. number returned to a batch file).
  97.  
  98.  
  99. V.  LINKING A PROGRAM
  100.  
  101. Set the focus to the window containing the program you want to 
  102. link. If you are linking a multi-module program, the window 
  103. should contain the program's main module. Choose "Link" from the 
  104. "Run" menu. You will be prompted by a dialog for the names of 
  105. any link modules; if this is a single-module program, just press 
  106. Enter.
  107.  
  108. If there are other modules to be linked to the current program, 
  109. type their names with a space between each. Press Enter.
  110.  
  111. The linker will also attempt to link the link library file to 
  112. your program, in case you have specified any external modules 
  113. (using the EXTRN directive). If you have the book by Irvine, 
  114. the library would be CONSOLE.LIB. (See section II, "Installing 
  115. Program Pathnames" in this manual for directions on selecting 
  116. a link library.)
  117.  
  118. By the way, if your program doesn't use any external routines, 
  119. the link library will just be ignored by the linker.
  120.  
  121.  
  122. VI.  RUNNING THE PROGRAM
  123.  
  124. You can run your linked program just "as is" by choosing the 
  125. "Run" command from the "Run" menu. Or, you can run your program 
  126. with the debugger, by selecting "Debug" from the "Run" menu.
  127.  
  128. If you want to pass parameters to your program see the following
  129. section, entitled "Setting Command-Line Parameters".
  130.  
  131.  
  132. VII.  SETTING COMMAND-LINE PARAMETERS
  133.  
  134. If you want to pass a command line to the program select the
  135. "Parameters" option from the "Run" menu.
  136.  
  137.